IsIconRefComposite

Reports whether a specified IconRef has been composited.



 
pascal OSErr IsIconRefComposite(

                     IconRef compositeIconRef,

                     IconRef*backgroundIconRef,

                     IconRef*foregroundIconRef)

compositeIconRef: A value of type IconRef that you wish to test to determine whether it has been composited.
backgroundIconRef: A pointer to a value of type IconRef . On return, this points to the IconRef value that forms the background of the IconRef specified in the compositeIconRef parameter. If the IconRef specified in the compositeIconRef parameter is not a composite, the return value is 0.
foregroundIconRef: A pointer to a value of type IconRef . On return, this points to the IconRef value that forms the foreground of the IconRef specified in the compositeIconRef parameter. If the IconRef specified in the compositeIconRef parameter is not a composite, the return value is 0.
function result: A result code. See Icon Services Result Codes for a description of possible return values.

DISCUSSION

The function CompositeIconRef allows the creation of a composite IconRef from a given background IconRef and a given foreground IconRef . The IsIconRefComposite function checks a specified IconRef to determine whether it is a composite and, if so, provides the background and foreground IconRef values.